define({ "api": [
  {
    "type": "POST",
    "url": "/v1/auth/resetpwd",
    "title": "4. 重置密码",
    "name": "auth_resetpwd",
    "version": "0.0.1",
    "description": "<p>重置(找回)密码, 密码修改成功后，客户端丢弃本地保存的jwtToken</p>",
    "group": "Auth",
    "permission": [
      {
        "name": "none"
      }
    ],
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "Mobile",
            "optional": false,
            "field": "mobile",
            "description": "<p>手机号</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "password",
            "description": "<p>新密码 （只需一个密码，密码重复确认由客户端本地校验）</p>"
          },
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "codeToken",
            "description": "<p>手机验证码校验接口返回的codeToken</p>"
          }
        ]
      }
    },
    "success": {
      "examples": [
        {
          "title": "成功-响应:",
          "content": "{\n    \"code\":0,\n    \"data\": [],\n    \"message\":\"密码修改成功，请重新登录\"\n}",
          "type": "json"
        }
      ]
    },
    "filename": "application/apiv1/controller/Auth.php",
    "groupTitle": "Auth"
  },
  {
    "type": "POST",
    "url": "/v1/auth/login",
    "title": "1. 普通登录",
    "name": "login",
    "version": "0.0.1",
    "description": "<p>用于手机号、邮箱、用户名登录等,暂时只支持 手机号</p>",
    "group": "Auth",
    "permission": [
      {
        "name": "none"
      }
    ],
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "Mobile",
            "optional": false,
            "field": "loginname",
            "description": "<p>登录名称(手机号)</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "password",
            "description": "<p>密码</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "Number",
            "optional": false,
            "field": "uid",
            "description": "<p>用户ID</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "uname",
            "description": "<p>用户名</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "face",
            "description": "<p>头像</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "token",
            "description": "<p>JwtToken(用于头部Authorization)</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "成功-响应:",
          "content": "{\n    \"code\":0,\n    \"data\": {\n        \"uid\": 1000,\n        \"uname\": \"test\",\n        \"face\": \"http://xxxx\",\n        \"token\": \"xxx.xxx.xxx\"\n    },\n    \"message\":\"\"\n}",
          "type": "json"
        }
      ]
    },
    "filename": "application/apiv1/controller/Auth.php",
    "groupTitle": "Auth"
  },
  {
    "type": "POST",
    "url": "/v1/auth/logout",
    "title": "3. 退出登录",
    "name": "logout",
    "version": "0.0.1",
    "description": "<p>退出登录，客户端调用这个接口后，自行删除本地的jwtToken</p>",
    "group": "Auth",
    "permission": [
      {
        "name": "none"
      }
    ],
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "Mobile",
            "optional": false,
            "field": "loginname",
            "description": "<p>登录名称(手机号)</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "password",
            "description": "<p>密码</p>"
          }
        ]
      }
    },
    "success": {
      "examples": [
        {
          "title": "成功-响应:",
          "content": "{\n    \"code\":0,\n    \"data\": []\n    \"message\":\"退出成功\"\n}",
          "type": "json"
        }
      ]
    },
    "filename": "application/apiv1/controller/Auth.php",
    "groupTitle": "Auth"
  },
  {
    "type": "POST",
    "url": "/v1/auth/oplogin",
    "title": "2. 第三方登录注册",
    "name": "oplogin",
    "version": "0.0.1",
    "description": "<p>用于QQ、微信、微博登录或注册</p> <p>后端会根据openId和accessToken调用对应第三方平台接口进行信息确认</p> <p>使用流程：<br> 1、传 platformId 、openId、accessToken、check = 0<br> 后端判断用户是否注册过，若注册过，则返回用户信息可jwtToken，完成登录, jwtTokn客户端保存起来，后续请求放入Header Authorization中，作为用户登录token信息</p> <p>2、若用户没注册过<br> 则返回 code== 1001 错误码，表示需要客户端二次确认是否绑定手机</p> <p>3、若用户选择设置手机<br> 则 传 platformId 、openId、accessToken、check = 1 、mobile、 codeToken 参数，后端处理绑定帐号或注册新帐号</p> <p>4、若用户选择不设置手机 则传 platformId、openId、accessToken、check = 1 即可，后端处理用户注册</p>",
    "group": "Auth",
    "permission": [
      {
        "name": "none"
      }
    ],
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "platformId",
            "description": "<p>平台类型 [1微信|2微博|3QQ]</p>"
          },
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "openId",
            "description": "<p>openId</p>"
          },
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "accessToken",
            "description": "<p>accessToken</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "check",
            "description": "<p>二次确认是要绑定手机 [0默认|1二次确认]</p>"
          },
          {
            "group": "Parameter",
            "type": "Mobile",
            "optional": false,
            "field": "mobile",
            "description": "<p>手机号(可选) 当check==1时，如果这个字段有值，则表示用户选择绑定(或录入)手机，手机帐号存在时，则后端绑定帐号; 手机帐号不存在时，则后端新注册帐号</p>"
          },
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "codeToken",
            "description": "<p>手机验证码校验接口返回的codeToken(可选)</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "Number",
            "optional": false,
            "field": "uid",
            "description": "<p>用户ID</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "uname",
            "description": "<p>用户名</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "face",
            "description": "<p>头像</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "token",
            "description": "<p>JwtToken(用于头部Authorization)</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "成功-响应:",
          "content": "{\n    \"code\":0,\n    \"data\": {\n        \"uid\": 1000,\n        \"uname\": \"test\",\n        \"face\": \"http://xxxx\",\n        \"token\": \"xxx.xxx.xxx\"\n    },\n    \"message\":\"\"\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "examples": [
        {
          "title": "错误-响应",
          "content": "\n{\n    \"code\":1001,\n    \"data\": [],\n    \"message\":\"need check\",\n}",
          "type": "json"
        }
      ]
    },
    "filename": "application/apiv1/controller/Auth.php",
    "groupTitle": "Auth"
  },
  {
    "type": "GET",
    "url": "/v1/config/boot",
    "title": "1. 初始配置信息",
    "name": "boot_config",
    "version": "0.0.1",
    "description": "<p>APP启动时加载配置</p>",
    "group": "Config",
    "permission": [
      {
        "name": "none"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "Number",
            "optional": false,
            "field": "auditStatus",
            "description": "<p>审核状态 [1审核期 | 0非审核期], 该字段由iOS使用，用于判断是否处于审核期，屏蔽相关敏感功能</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "成功-响应:",
          "content": "{\n    \"code\":0,\n    \"data\": {\n        \"auditStatus\": 0, \n    },\n    \"message\":\"\"\n}",
          "type": "json"
        }
      ]
    },
    "filename": "application/apiv1/controller/Config.php",
    "groupTitle": "Config"
  },
  {
    "type": "GET",
    "url": "/v1/config/logic",
    "title": "2. 业务配置信息",
    "name": "logic_config",
    "version": "0.0.1",
    "description": "<p>APP业务相关的配置信息</p>",
    "group": "Config",
    "permission": [
      {
        "name": "none"
      }
    ],
    "success": {
      "examples": [
        {
          "title": "成功-响应:",
          "content": "{\n    \"code\":0,\n    \"data\": {\n        //字段待定\n    },\n    \"message\":\"\"\n}",
          "type": "json"
        }
      ]
    },
    "filename": "application/apiv1/controller/Config.php",
    "groupTitle": "Config"
  },
  {
    "type": "POST",
    "url": "/v1/mobile/checkcode",
    "title": "1. 检验手机验证码",
    "name": "mobile_checkcode",
    "version": "0.0.1",
    "description": "<p>检验手机验证码</p>",
    "group": "Mobile",
    "permission": [
      {
        "name": "none"
      }
    ],
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "checkType",
            "description": "<p>业务类型 [&quot;register&quot;(手机注册) | &quot;resetpwd&quot;(重置(找回)密码)]</p>"
          },
          {
            "group": "Parameter",
            "type": "Mobile",
            "optional": false,
            "field": "mobile",
            "description": "<p>手机号</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "code",
            "description": "<p>验证码</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "codeToken",
            "description": "<p>手机号成功验证的标识(传给下一个业务接口)</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "成功-响应:",
          "content": "{\n    \"code\":0,\n    \"data\": {\n        \"codeToken\": \"xxx.xxx.xxx\"\n    },\n    \"message\":\"\"\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "examples": [
        {
          "title": "错误-响应:",
          "content": "{\n    \"code\":10001,\n    \"data\": [],\n    \"message\":\"参数错误\"\n}\n\n{\n    \"code\":10002,\n    \"data\": [],\n    \"message\":\"验证吗错误\"\n}",
          "type": "json"
        }
      ]
    },
    "filename": "application/apiv1/controller/Mobile.php",
    "groupTitle": "Mobile"
  },
  {
    "type": "GET",
    "url": "/v1/package/check",
    "title": "1. 检查更新",
    "name": "package_check",
    "version": "0.0.1",
    "description": "<p>检查更新</p>",
    "group": "Package",
    "permission": [
      {
        "name": "none"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "Number",
            "optional": false,
            "field": "version",
            "description": "<p>APP最新版本号(本地版本小于服务端版本时弹更新提示)</p>"
          },
          {
            "group": "Success 200",
            "type": "Number",
            "optional": false,
            "field": "force",
            "description": "<p>是否要求强制更新 [1(是) | 0(否)]</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "downurl",
            "description": "<p>下载地址(iOS官方版本无视这个字段)</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "desc",
            "description": "<p>更新简介</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "成功-响应:",
          "content": "{\n    \"code\":0,\n    \"data\": {\n        \"version\":1000,\n        \"force\":0,\n        \"downurl\":\"http://xxx/x.apk\",\n        \"desc\":\"版本更新描述\"\n    },\n    \"message\":\"\"\n}",
          "type": "json"
        }
      ]
    },
    "filename": "application/apiv1/controller/Package.php",
    "groupTitle": "Package"
  },
  {
    "type": "POST",
    "url": "/v1/register/mobile",
    "title": "1. 手机注册",
    "name": "____",
    "version": "0.0.1",
    "description": "<p>手机注册，成功创建新用户，并返回基本用户信息和token</p>",
    "group": "Register",
    "permission": [
      {
        "name": "none"
      }
    ],
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "mobile",
            "optional": false,
            "field": "mobile",
            "description": "<p>手机号</p>"
          },
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "password",
            "description": "<p>密码（只需一个密码，密码重复确认由客户端本地校验）</p>"
          },
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "codeToken",
            "description": "<p>上一步手机验证码校验接口返回的codeToken</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "Number",
            "optional": false,
            "field": "uid",
            "description": "<p>用户ID</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "uname",
            "description": "<p>用户名</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "face",
            "description": "<p>头像</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "token",
            "description": "<p>JwtToken(用于头部Authorization)</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "成功-响应:",
          "content": "{\n    \"code\":0,\n    \"data\": {\n        \"uid\":1000,\n        \"uname\":\"test\",\n        \"face\":\"http://xxxx\",\n        \"token\": \"xxx.xxx.xxx\"\n    },\n    \"message\":\"\"\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "examples": [
        {
          "title": "错误-响应:",
          "content": "{\n    \"code\":10001,\n    \"data\": [],\n    \"message\":\"参数错误\"\n}\n\n{\n    \"code\":10003,\n    \"data\": [],\n    \"message\":\"Expired token\"\n}",
          "type": "json"
        }
      ]
    },
    "filename": "application/apiv1/controller/Register.php",
    "groupTitle": "Register"
  },
  {
    "type": "POST",
    "url": "/v1/userinfo/get",
    "title": "1.用户基础信息",
    "name": "______",
    "version": "0.0.1",
    "description": "<p>获取用户基础信息</p>",
    "group": "UserInfo",
    "permission": [
      {
        "name": "需要登录"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "Number",
            "optional": false,
            "field": "uid",
            "description": "<p>用户ID</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "uname",
            "description": "<p>用户名</p>"
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "face",
            "description": "<p>头像</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "成功-响应:",
          "content": "{\n    \"code\":0,\n    \"data\": {\n        \"uid\":1000,\n        \"uname\":\"test\",\n        \"face\":\"http://xxxx\",\n    },\n    \"message\":\"\"\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "examples": [
        {
          "title": "错误-响应:",
          "content": "{\n    \"code\":1000,\n    \"data\": [],\n    \"message\":\"用户未登录\"\n}",
          "type": "json"
        }
      ]
    },
    "filename": "application/apiv1/controller/UserInfo.php",
    "groupTitle": "UserInfo"
  }
] });
